<?php
/**
 * I know no such things as genius,it is nothing but labor and diligence.
 *
 * @copyright (c) 2015~2019 BD All rights reserved.
 * @license http://www.apache.org/licenses/LICENSE-2.0
 * @author BD<657306123@qq.com>
 */
namespace xin\iplocation;

/**
 *  IP 地理位置查询类 修改自 CoolCode.CN
 *  由于使用UTF8编码 如果使用纯真IP地址库的话 需要对返回结果进行编码转换
 *
 * @author    liu21st <liu21st@gmail.com>
 * 修改日期 2015.4.27 明天见 386117932
 */
final class IpLocation{

	/**
	 * QQWry.Dat文件指针
	 *
	 * @var resource
	 */
	private $fp;

	/**
	 * 第一条IP记录的偏移地址
	 *
	 * @var int
	 */
	private $firstIp;

	/**
	 * 最后一条IP记录的偏移地址
	 *
	 * @var int
	 */
	private $lastIp;

	/**
	 * IP记录的总条数（不包含版本信息记录）
	 *
	 * @var int
	 */
	private $totalIp;

	/**
	 * 构造函数，打开 QQWry.Dat 文件并初始化类中的信息
	 *
	 * @param string $filename
	 * @throws \RuntimeException
	 */
	public function __construct($filename = "UTFWry.dat"){
		$this->fp = 0;
		if(($this->fp = fopen(dirname(__FILE__).'/'.$filename, 'rb')) !== false){
			$this->firstIp = $this->getLong();
			$this->lastIp = $this->getLong();
			$this->totalIp = ($this->lastIp - $this->firstIp) / 7;
		}else{
			throw new \RuntimeException("数据文件不存在!");
		}
	}

	/**
	 * 返回读取的长整型数
	 *
	 * @access private
	 * @return int
	 */
	private function getLong(){
		//将读取的little-endian编码的4个字节转化为长整型数
		$result = unpack('Vlong', fread($this->fp, 4));
		return $result['long'];
	}

	/**
	 * 简化操作
	 *
	 * @access public
	 * @return string
	 */
	public function getIpAddress(){
		$str = $this->getLocation();
		return $str['country'] ? $str['country'] : '';
	}

	/**
	 * 根据所给 IP 地址或域名返回所在地区信息
	 *
	 * @access public
	 * @param string $ip
	 * @return array
	 */
	public function getLocation($ip = ''){
		if(!$this->fp){
			return null;
		}
		// 如果数据文件没有被正确打开，则直接返回空
		if(empty($ip)){
			$ip = $this->getClientIp();
		}
		if(!is_numeric($ip)){
			$location['ip'] = gethostbyname($ip); // 将输入的域名转化为IP地址
			$ip = $this->packIp($location['ip']); // 将输入的IP地址转化为可比较的IP地址
		}else{
			$location['ip'] = long2ip($ip);
		}
		// 不合法的IP地址会被转化为255.255.255.255
		// 对分搜索
		$l = 0; // 搜索的下边界
		$u = $this->totalIp; // 搜索的上边界
		$findip = $this->lastIp; // 如果没有找到就返回最后一条IP记录（QQWry.Dat的版本信息）
		while($l <= $u){
			// 当上边界小于下边界时，查找失败
			$i = floor(($l + $u) / 2); // 计算近似中间记录
			fseek($this->fp, $this->firstIp + $i * 7);
			$beginip = strrev(fread($this->fp, 4)); // 获取中间记录的开始IP地址
			// strrev函数在这里的作用是将little-endian的压缩IP地址转化为big-endian的格式
			// 以便用于比较，后面相同。
			if($ip < $beginip){ // 用户的IP小于中间记录的开始IP地址时
				$u = $i - 1; // 将搜索的上边界修改为中间记录减一
			}else{
				fseek($this->fp, $this->getLong3());
				$endip = strrev(fread($this->fp, 4)); // 获取中间记录的结束IP地址
				if($ip > $endip){ // 用户的IP大于中间记录的结束IP地址时
					$l = $i + 1; // 将搜索的下边界修改为中间记录加一
				}else{
					// 用户的IP在中间记录的IP范围内时
					$findip = $this->firstIp + $i * 7;
					break; // 则表示找到结果，退出循环
				}
			}
		}

		//获取查找到的IP地理位置信息
		fseek($this->fp, $findip);
		$location['beginip'] = long2ip($this->getLong()); // 用户IP所在范围的开始地址
		$offset = $this->getLong3();
		fseek($this->fp, $offset);
		$location['endip'] = long2ip($this->getLong()); // 用户IP所在范围的结束地址
		$byte = fread($this->fp, 1); // 标志字节
		switch(ord($byte)){
			case 1: // 标志字节为1，表示国家和区域信息都被同时重定向
				$countryOffset = $this->getLong3(); // 重定向地址
				fseek($this->fp, $countryOffset);
				$byte = fread($this->fp, 1); // 标志字节
				switch(ord($byte)){
					case 2: // 标志字节为2，表示国家信息又被重定向
						fseek($this->fp, $this->getLong3());
						$location['country'] = $this->getString();
						fseek($this->fp, $countryOffset + 4);
						$location['area'] = $this->getArea();
						break;
					default: // 否则，表示国家信息没有被重定向
						$location['country'] = $this->getString($byte);
						$location['area'] = $this->getArea();
						break;
				}
				break;
			case 2: // 标志字节为2，表示国家信息被重定向
				fseek($this->fp, $this->getLong3());
				$location['country'] = $this->getString();
				fseek($this->fp, $offset + 8);
				$location['area'] = $this->getArea();
				break;
			default: // 否则，表示国家信息没有被重定向
				$location['country'] = $this->getString($byte);
				$location['area'] = $this->getArea();
				break;
		}
		if(trim($location['country']) == 'CZ88.NET'){
			// CZ88.NET表示没有有效信息
			$location['country'] = '未知';
		}
		if(trim($location['area']) == 'CZ88.NET'){
			$location['area'] = '';
		}
		return $location;
	}

	/**
	 * 获取客户端IP地址
	 *
	 * @param integer $type 返回类型 0 返回IP地址 1 返回IPV4地址数字
	 * @param boolean $adv 是否进行高级模式获取（有可能被伪装）
	 * @return mixed
	 */
	function getClientIp($type = 0, $adv = false){
		$type = $type ? 1 : 0;
		static $ip = null;
		if(null !== $ip){
			return $ip[$type];
		}

		if($adv){
			if(isset($_SERVER['HTTP_X_FORWARDED_FOR'])){
				$arr = explode(',', $_SERVER['HTTP_X_FORWARDED_FOR']);
				$pos = array_search('unknown', $arr);
				if(false !== $pos){
					unset($arr[$pos]);
				}

				$ip = trim($arr[0]);
			}elseif(isset($_SERVER['HTTP_CLIENT_IP'])){
				$ip = $_SERVER['HTTP_CLIENT_IP'];
			}elseif(isset($_SERVER['REMOTE_ADDR'])){
				$ip = $_SERVER['REMOTE_ADDR'];
			}
		}elseif(isset($_SERVER['REMOTE_ADDR'])){
			$ip = $_SERVER['REMOTE_ADDR'];
		}
		// IP地址合法验证
		$long = sprintf("%u", ip2long($ip));
		$ip = $long ? [$ip, $long] : ['0.0.0.0', 0];
		return $ip[$type];
	}

	/**
	 * 返回压缩后可进行比较的IP地址
	 *
	 * @access private
	 * @param string $ip
	 * @return string
	 */
	private function packIp($ip){
		// 将IP地址转化为长整型数，如果在PHP5中，IP地址错误，则返回False，
		// 这时intval将Flase转化为整数-1，之后压缩成big-endian编码的字符串
		return pack('N', intval(ip2long($ip)));
	}

	/**
	 * 返回读取的3个字节的长整型数
	 *
	 * @access private
	 * @return int
	 */
	private function getLong3(){
		//将读取的little-endian编码的3个字节转化为长整型数
		$result = unpack('Vlong', fread($this->fp, 3).chr(0));
		return $result['long'];
	}

	/**
	 * 返回读取的字符串
	 *
	 * @access private
	 * @param string $data
	 * @return string
	 */
	private function getString($data = ""){
		$char = fread($this->fp, 1);
		while(ord($char) > 0){
			// 字符串按照C格式保存，以\0结束
			$data .= $char; // 将读取的字符连接到给定字符串之后
			$char = fread($this->fp, 1);
		}
		return $data;
	}

	/**
	 * 返回地区信息
	 *
	 * @access private
	 * @return string
	 */
	private function getArea(){
		$byte = fread($this->fp, 1); // 标志字节
		switch(ord($byte)){
			case 0: // 没有区域信息
				$area = "";
				break;
			case 1:
			case 2: // 标志字节为1或2，表示区域信息被重定向
				fseek($this->fp, $this->getLong3());
				$area = $this->getString();
				break;
			default: // 否则，表示区域信息没有被重定向
				$area = $this->getString($byte);
				break;
		}
		return $area;
	}

	/**
	 * 析构函数，用于在页面执行结束后自动关闭打开的文件。
	 */
	public function __destruct(){
		if($this->fp){
			fclose($this->fp);
		}
		$this->fp = 0;
	}

}
